Structured Headings
Domain Message Specification

Version: 1.0; Status: RC3

Consent Tabular View

COCD_TP146226GB02
Consent

This template class constrains the CDA Consent class.

The Consent template details the consents associated with this CDA document.

The type of consent (e.g. a consent to perform the related service event, a consent for the information contained in the document to be released to a third party) is conveyed in Consent.code. Consents referred to in the CDA header have been finalised (Consent.statusCode must equal "completed") and should be on file.

Used by:
[1..1] [M] classCode (CS { CNE: ActClass } )
{ Fixed="CONS" }

Model Attribute Description

The HL7 attribute classCode uses a code to describe this class as a consent.

Implementation in XML Instance

  • The XML attribute classCode is fixed to "CONS".
[1..1] [M] moodCode (CS { CNE: ActMood } )
{ Fixed="EVN" }

Model Attribute Description

The HL7 attribute moodCode uses a code to describe this class as a consent event.

Implementation in XML Instance

  • The XML attribute moodCode is fixed to "EVN".
[1..1] [M] code (CE { CWE:DocumentConsentSnCT } )

Model Attribute Description

The HL7 attribute code uses a code from DocumentConsentSnCT or an alternative vocabulary to describe the type of consent that is associated with the document.

Implementation in XML Instance

The Coded Value (CV) data type shall be used to carry this information in the XML element code as follows:

When using the DocumentConsentSnCT vocabulary then:

  • The XML attribute xsi:typeshall contain the value "CV".
  • The XML attribute code shall contain a code from the SNOMED CT subset stated
  • The XML attribute codeSystem shall contain the OID "2.16.840.1.113883.2.1.3.2.4.15"
  • The XML attribute displayName shall carry a description associated with the SNOMED CT code. It is recommended that the preferred term is used to populate this attribute
  • The XML element originalText may be used if required to carry the text or phrase used as the basis for the coding
When using a code from an alternative vocabulary and no OID is available on the sending system then:
  • The XML attribute xsi:typeshall contain the value "CV".
  • The XML attribute code shall contain the code
  • The XML attribute codeSystem shall contain the OID "2.16.840.1.113883.2.1.3.2.4.17.334"
  • The XML attribute displayName shall carry a description associated with the code
  • The XML element originalText may be used if required to carry the text or phrase used as the basis for the coding

When using a code from an alternative vocabulary and an OID is available on the sending system then:

  • The XML attribute code shall contain the code
  • The XML attribute codeSystem shall contain the OID for the alternative vocabulary
  • The XML attribute displayName shall carry a description associated with the code
  • The XML element originalText may be used if required to carry the text or phrase used as the basis for the coding
[1..*] [M] id (SET<II>)

Model Attribute Description

The HL7 attribute id uses an identifier to identify an instance of a consent.

Implementation in XML Instance

The Identifier Global data type flavour shall be used to carry this information in the XML element id in at least one of the following ways:

When using a DCE UUID to identify the consent

  • The XML attribute root shall contain a DCE UUID

When using a local identifier

  • The XML attribute root shall contain the OID "2.16.840.1.113883.2.1.3.2.4.18.39"
  • The XML attribute extension shall contain the local identifier
  • The XML attribute assigningAuthorityName shall contain the assigning organisation in the format of ODSCode:ODSName, for example:

assigningAuthorityName="RA9:SOUTH DEVON HEALTHCARE NHS TRUST"

[1..1] [M] statusCode (CS { CNE:ActStatus } )
{ Fixed="completed" }

Model Attribute Description

The HL7 attribute statusCode describes the status of the consent. The consent associated with the CDA document has been finalized and is on file.

Implementation in XML Instance

The Coded Only flavour of the Coded Simple (CS) data type shall be used to carry this information in the XML element statusCode as follows:

  • The XML attribute code is fixed to "completed".
[1..1] [M] templateId (II)
{ Fixed="COCD_TP146226GB02#Consent" }
Model Attribute Description

The HL7 attribute templateId provides a unique identifier for the template and the classname within that template. This is used to identify how the CDA standard has been constrained for NHS use.

Implementation in XML Instance

The Identifier External data type flavour is used to carry this information in the XML element templateId as follows:
  • The XML attribute root is fixed to the OID "2.16.840.1.113883.2.1.3.2.4.18.2"
  • The XML attribute extension is fixed to "COCD_TP146226GB02#Consent"